Dont display tooltips on platforms that dont support hover #12168

roryabraham · 2022-10-26T23:24:20Z

Details

Prevent displaying tooltips on platforms that don't support hover.
Implements Tooltips using a React Native-compatible Portal implementation rather than web-specific ReactDOM.createPortal, which in turn:
- will allow us to test Tooltips in a RN environment using react-native-testing-library
- provides a more transparent implementation
- opens doors down the line for mouse-enabled tablets to have tooltips (not currently supported)

Fixed Issues

$ #9737
PROPOSAL: #9737 (comment)

Tests

Touch-screen devices

Go to chat with someone
Go back from chat using back button and open chat again and go back.
Repeat this process multiple times and verify that no tooltip appears when back on chat screen

Web/Desktop (narrow screens)

Open a chat
Hover over the back button – a tooltip that says Back should appear.
Hover away from the back button – the tooltip should disappear.
Hover over the back button – a tooltip that says Back should appear.
Click on the back button – the LHN should open and the tooltip should disappear.

Web/Desktop (wide screen)

n/a

Verify that no errors appear in the JS console

QA Steps

Same as tests.

Verify that no errors appear in the JS console

PR Review Checklist

PR Author Checklist

PR Reviewer Checklist

The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed

Screenshots

Web

WebNarrowTooltip.mov

WebWideTooltip.mov

Mobile Web - Chrome

screen-20230102-183325.mp4

Mobile Web - Safari

RPReplay_Final1672708413.MP4

Desktop

DesktopNarrow.mov

DesktopWide.mov

iOS

RPReplay_Final1672709013.MP4

Android

video.mp4

… library

melvin-bot · 2022-10-26T23:24:23Z

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

# Conflicts: # package-lock.json # package.json # src/components/DatePicker/index.js

roryabraham · 2022-11-17T01:39:32Z

src/components/Tooltip/index.js

-        // Skip the tooltip and return the children, if the text is empty.
-        if (_.isEmpty(this.props.text)) {
+        // Skip the tooltip and return the children if the text is empty or the device does not support hovering
+        if (_.isEmpty(this.props.text) || !this.hasHoverSupport) {


This is the most critical behavior change in this PR

ios/Podfile.lock

package.json

src/libs/DeviceCapabilities/hasHoverSupport/index.js

melvin-bot · 2023-01-03T02:39:39Z

@Santhosh-Sellavel @alex-mechler One of you needs to copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

roryabraham · 2023-01-03T02:46:53Z

Ready for review. Note that there is a bug in the videos that also exists on main and in production: https://expensify.slack.com/archives/C049HHMV9SM/p1672706945551159

tgolen

Looks much better now, thank you!

Santhosh-Sellavel · 2023-01-03T21:16:45Z

Looks fine but will get to this again, tomorrow.

Santhosh-Sellavel · 2023-01-05T00:57:56Z

src/styles/getTooltipStyles.js

-            //      so that the top of the pointer aligns with the bottom of the component.
-            //
-            // Always add the manual vertical shift passed in as a parameter.
-            top: shouldShowBelow ? (manualShiftVertical - POINTER_HEIGHT) : (tooltipHeight + manualShiftVertical),
+            //   OR if the pointer should be above the tooltip wrapper, then the pointer up (-) by the pointer's height
+            //   so that the bottom of the pointer lines up with the top of the tooltip
+            top: shouldShowBelow ? -POINTER_HEIGHT : tooltipHeight,


Here we removed manualShiftVertical can you explain why it's not needed?

@alex-mechler just waiting for this

Cc: @tgolen

Hi! What can I help with?

Good catch @Santhosh-Sellavel. I think manualShiftVertical wasn't really working so I removed it for testing, but I'm going to re-investigate this and see if it's needed or not and if I can fix it.

Oh, got it this was just on the pointer. You can test but manualShiftVertical seems to work as expected:

offsetVertical: 4

offsetVertical: 24

offsetVertical: -24

Santhosh-Sellavel · 2023-01-05T01:04:00Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is correct English and approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web & Desktop

Screen.Recording.2023-01-08.at.1.18.29.AM.mov

Mobile Web - Chrome & Mobile Web - Safari

Screen.Recording.2023-01-08.at.1.42.50.AM.mov

iOS & Android

Screen.Recording.2023-01-08.at.2.10.20.AM.mov

alex-mechler

This lgtm, and works well. @Santhosh-Sellavel are you able to finish off the checklist?

tgolen · 2023-01-06T19:12:00Z

bump @Santhosh-Sellavel ^

# Conflicts: # src/components/Tooltip/index.js

roryabraham · 2023-01-07T00:47:00Z

Conflicts resolved

Santhosh-Sellavel

LGTM tests well!

OSBotify · 2023-01-07T22:24:51Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-01-09T19:08:42Z

🚀 Deployed to staging by @roryabraham in version: 1.2.51-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

alex-mechler · 2023-01-10T00:08:44Z

This has caused #14149, which I confirmed by reverting this pr locally.

I've tried fixing this locally, but have been unable. We properly call to update the tooltip width, but are improperly calculating the width of it.

OSBotify · 2023-01-10T16:17:52Z

🚀 Deployed to production by @Julesssss in version: 1.2.51-1 🚀

platform	result
🤖 android 🤖	failure ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

alex-mechler · 2023-01-12T23:42:17Z

To follow up on the above, this was caused by the switch to <Portal>, which caused delays in measurements. This lead to the updated width being improperly calculated

Santhosh-Sellavel · 2023-08-08T21:14:28Z

We have improved hover logic, still on Android mWeb there are cases where hover is detected for multiple taps, some devices support hover which led to this issue. More details refer here

roryabraham added 5 commits October 27, 2022 00:02

Create function to detect internet explorer

d78b0d0

Create more accurate implementation of hasHoverSupport

2f372e2

Handle edge case for ancient IE mobile

1faba5d

Add documentation for IE edge case

346e074

Combine canUseTouchscreen and hasHoverSupport into DeviceCapabilities…

852c0c3

… library

roryabraham changed the title ~~Create function to detect internet explorer~~ [WIP] Dont display tooltips on platforms that dont support hover Oct 26, 2022

roryabraham added 6 commits October 27, 2022 00:46

Dont render tooltips if the device does not support hover

5e8f723

Upgrade testing-library/react-native and transitive peer dependencies

a8360e5

Merge branch 'main' into Rory-NoTooltipWithoutMouse

18ff316

# Conflicts: # package-lock.json # package.json # src/components/DatePicker/index.js

Reinstall packages after merge

d17c423

Reapply changes from 12078

9091ee5

Add eslint-plugin-lwc transitive dependency

932d999

roryabraham commented Nov 17, 2022

View reviewed changes

roryabraham added 11 commits November 16, 2022 17:49

Nix deprecated babel-eslint and replace with @babel/eslint-parser

f8938cf

Separately install jest-environment-jsdom

22da5de

Migrate to DeviceCapabilities lib in OptionsList/index.js

f583bdf

Fix JS style

e7f26c3

Upgrade jest to match jest-environment-eslint

6b473ed

Upgrade babel/preset-env

3b0e1b2

Fix babel config

e9097a7

Upgrade reanimated to fix jest 28 bug

5652989

Fix noisy loose tests

f720dac

Fix fake timers

0b3123e

Create draft of TooltipTest

515a3c3

roryabraham mentioned this pull request Nov 18, 2022

Tooltip appears sometimes when go back from chat (mWeb - Safari) - reported by @aneequeahmad #9737

Closed

roryabraham commented Nov 18, 2022

View reviewed changes

ios/Podfile.lock Outdated Show resolved Hide resolved

roryabraham commented Nov 18, 2022

View reviewed changes

package.json Outdated Show resolved Hide resolved

roryabraham commented Nov 18, 2022

View reviewed changes

package.json Outdated Show resolved Hide resolved

tgolen requested changes Dec 12, 2022

View reviewed changes

src/libs/DeviceCapabilities/hasHoverSupport/index.js Show resolved Hide resolved

tgolen previously approved these changes Jan 3, 2023

View reviewed changes

Santhosh-Sellavel reviewed Jan 5, 2023

View reviewed changes

alex-mechler previously approved these changes Jan 5, 2023

View reviewed changes

Merge branch 'main' into Rory-NoTooltipWithoutMouse

d3aa664

# Conflicts: # src/components/Tooltip/index.js

roryabraham dismissed stale reviews from alex-mechler and tgolen via d3aa664 January 7, 2023 00:46

roryabraham requested review from tgolen, alex-mechler and Santhosh-Sellavel January 7, 2023 00:46

tgolen approved these changes Jan 7, 2023

View reviewed changes

Santhosh-Sellavel approved these changes Jan 7, 2023

View reviewed changes

roryabraham merged commit a53b274 into main Jan 7, 2023

roryabraham deleted the Rory-NoTooltipWithoutMouse branch January 7, 2023 22:18

roryabraham mentioned this pull request Jan 7, 2023

Figure out why PR 13944 was accidentally merged #14116

Closed

OSBotify mentioned this pull request Jan 9, 2023

Deploy Checklist: New Expensify 2023-01-09 #14145

Closed

10 tasks

alex-mechler mentioned this pull request Jan 9, 2023

[HOLD for payment 2023-01-19] Unpin tooltip text is splitting into 2 lines #14149

Closed

2 tasks

BeeMargarida mentioned this pull request Jun 30, 2023

[HOLD for payment 2023-07-14] [$1000] The tooltip disappears when the "Copy to clipboard" option is clicked multiple times. #19693

Closed

6 tasks

Santhosh-Sellavel mentioned this pull request Aug 8, 2023

[HOLD for payment 2023-08-03] [$1000] mWeb - Horizontal message settings being displayed on mobile #22759

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dont display tooltips on platforms that dont support hover #12168

Dont display tooltips on platforms that dont support hover #12168

roryabraham commented Oct 26, 2022 •

edited

Loading

melvin-bot bot commented Oct 26, 2022

roryabraham Nov 17, 2022

melvin-bot bot commented Jan 3, 2023

roryabraham commented Jan 3, 2023

tgolen left a comment

Santhosh-Sellavel commented Jan 3, 2023

Santhosh-Sellavel Jan 5, 2023

Santhosh-Sellavel Jan 6, 2023

Santhosh-Sellavel Jan 6, 2023

tgolen Jan 6, 2023

roryabraham Jan 6, 2023

roryabraham Jan 7, 2023 •

edited

Loading

Santhosh-Sellavel commented Jan 5, 2023 •

edited

Loading

alex-mechler left a comment

tgolen commented Jan 6, 2023

roryabraham commented Jan 7, 2023

Santhosh-Sellavel left a comment

OSBotify commented Jan 7, 2023

OSBotify commented Jan 9, 2023

alex-mechler commented Jan 10, 2023

OSBotify commented Jan 10, 2023

alex-mechler commented Jan 12, 2023

Santhosh-Sellavel commented Aug 8, 2023


`offsetVertical: 4`
`offsetVertical: 24`
`offsetVertical: -24`

Dont display tooltips on platforms that dont support hover #12168

Dont display tooltips on platforms that dont support hover #12168

Conversation

roryabraham commented Oct 26, 2022 • edited Loading

Details

Fixed Issues

Tests

Touch-screen devices

Web/Desktop (narrow screens)

Web/Desktop (wide screen)

QA Steps

PR Review Checklist

PR Author Checklist

PR Reviewer Checklist

Screenshots

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot bot commented Oct 26, 2022

roryabraham Nov 17, 2022

Choose a reason for hiding this comment

melvin-bot bot commented Jan 3, 2023

roryabraham commented Jan 3, 2023

tgolen left a comment

Choose a reason for hiding this comment

Santhosh-Sellavel commented Jan 3, 2023

Santhosh-Sellavel Jan 5, 2023

Choose a reason for hiding this comment

Santhosh-Sellavel Jan 6, 2023

Choose a reason for hiding this comment

Santhosh-Sellavel Jan 6, 2023

Choose a reason for hiding this comment

tgolen Jan 6, 2023

Choose a reason for hiding this comment

roryabraham Jan 6, 2023

Choose a reason for hiding this comment

roryabraham Jan 7, 2023 • edited Loading

Choose a reason for hiding this comment

Santhosh-Sellavel commented Jan 5, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

alex-mechler left a comment

Choose a reason for hiding this comment

tgolen commented Jan 6, 2023

roryabraham commented Jan 7, 2023

Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

OSBotify commented Jan 7, 2023

OSBotify commented Jan 9, 2023

alex-mechler commented Jan 10, 2023

OSBotify commented Jan 10, 2023

alex-mechler commented Jan 12, 2023

Santhosh-Sellavel commented Aug 8, 2023

roryabraham commented Oct 26, 2022 •

edited

Loading

roryabraham Jan 7, 2023 •

edited

Loading

Santhosh-Sellavel commented Jan 5, 2023 •

edited

Loading